fix(docs/single): support files with .markdown extension
#549
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fixing typo, removing unused version param, stricter error checks
kanadgupta
added
bug
erunion
reviewed
Jul 28, 2022
src/cmds/changelogs/single.js
Outdated
| @@ -45,7 +45,7 @@ module.exports = class SingleChangelogCommand { | |||
| return Promise.reject(new Error(`No file path provided. Usage \`${config.get('cli')} ${this.usage}\`.`)); | |||
| } | |||
|
|
|||
| if (filePath.endsWith('.md') === false || !filePath.endsWith('.markdown') === false) { | |||
| if (!(filePath.endsWith('.md') || filePath.endsWith('.markdown'))) { | |||
There was a problem hiding this comment.
I've had case-sensitive filesystems on my mind this week and I'm wondering if we should support .MD and .Markdown, or any casing variation of them.
src/cmds/changelogs/single.js
Outdated
| @@ -45,7 +45,7 @@ module.exports = class SingleChangelogCommand { | |||
| return Promise.reject(new Error(`No file path provided. Usage \`${config.get('cli')} ${this.usage}\`.`)); | |||
| } | |||
|
|
|||
| if (filePath.endsWith('.md') === false || !filePath.endsWith('.markdown') === false) { | |||
| if (!(filePath.endsWith('.md') || filePath.endsWith('.markdown'))) { | |||
| return Promise.reject(new Error('The file path specified is not a markdown file.')); | |||
There was a problem hiding this comment.
Does this need to be capitalized?
Suggested change
| return Promise.reject(new Error('The file path specified is not a markdown file.')); | |
| return Promise.reject(new Error('The file path specified is not a Markdown file.')); |
erunion
approved these changes
Jul 28, 2022
kanadgupta
added a commit
that referenced
this pull request
Jul 28, 2022
* chore: create custompages cmd category * test: fixtures * feat: initial pass at commands as part of this, we had to slightly refactor the pushDoc function to augment the data to support the HTML file handling required by the custompages API * test: initial pass at tests * docs: update README usage * test: remove unused version params, stricter error checks * fix(docs/single): support files with `.markdown` extension (#549) * fix: support files with .markdown extension * test: random cleanup fixing typo, removing unused version param, stricter error checks * chore: capitalize Markdown * chore: lowercase all file extension checks * refactor: DRY some docs logic (#550) * fix: support files with .markdown extension * test: random cleanup fixing typo, removing unused version param, stricter error checks * refactor: DRY some docs logic * feat: add retag-release workflow to add a vX.Y.Z tag for our GitHub Action (#545) * feat: add retag-release workflow to add a vX.Y.Z tag for our GitHub Action * Update .github/workflows/retag-release.yaml Co-authored-by: Kanad Gupta <[email protected]> * refactor: move code out of YAML and into bin/ script * fix: lint fixes Co-authored-by: Kanad Gupta <[email protected]> Co-authored-by: Ryan Park <[email protected]> Co-authored-by: Ryan Park <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🧰 Changes
Fixes an issue where our single commands had faulty conditional logic and therefore weren't working on
.markdownfiles properly.Also leans up a few tests, see 21ba907
🧬 QA & Testing
Do the test changes look good and do they pass?